feat(metadata/doctrine): Use `Type` of `TypeInfo` instead of `PropertyInfo` #6979

mtarld · 2025-02-21T14:43:20Z

Q	A
Branch?	main
Tickets
License	MIT
Doc PR

In order to anticipate the deprecation of PropertyInfo's Type in favor of TypeInfo's one, this PR adds a new property phpType (the name can be challenged) that will aim to replace builtinTypes.

What has been done:

Add ApiProperty::$phpType property, ApiProperty::getPhpType(), and ApiProperty::withPhpType().
Add PropertyInfoToTypeInfoHelper::convertTypeToLegacyTypes to store legacy types in ApiProperty::$builtinTypes when setting ApiProperty::$phpType, this allows API Platform to work "the legacy way" while upgrading other packages.
Doesn't trigger deprecations yet in ApiProperty to allow other API Platform packages to upgrade first.
Update AbstractItemNormalizer to not be dependent on the type order (type order might not be the same with these changes)
Implement PropertyTypeExtractorInterface::getType() in DoctrineExtractor (as getTypes is deprecated)
Bump api-platform/metadata to ^4.1, symfony/property-info to ^7.1 in all packages
Require symfony/type-info:^7.2 in api-platform/metadata and api-platform/doctrine

mtarld · 2025-02-24T10:29:19Z

For information, the code can become simpler if the following PRs get merged:

symfony/symfony#59844 will update

$typeIsResourceClass = function (Type $type) use (&$typeIsResourceClass): bool {
    return match (true) {
        $type instanceof CollectionType => $type->getCollectionValueType()->isSatisfiedBy($typeIsResourceClass),
        $type instanceof WrappingTypeInterface => $type->wrappedTypeIsSatisfiedBy($typeIsResourceClass),
        $type instanceof CompositeTypeInterface => $type->composedTypesAreSatisfiedBy($typeIsResourceClass),
        default => $type instanceof ObjectType && $this->isResourceClass($type->getClassName()),
    };
};

to

$typeIsResourceClass = fn (Type $type): bool => $type instanceof ObjectType && $this->isResourceClass($type->getClassName());

symfony/symfony#59845 will update

foreach ($type instanceof CompositeTypeInterface ? $type->getTypes() : [$type] as $t) {
    while ($t instanceof WrappingTypeInterface) {
        $t = $t->getWrappedType();
    }

    $typeStrings[] = (string) $t;
}

to

foreach ($type->traverse() as $t) {
    if ($t instanceof CompositeTypeInterface || $t instanceof WrappingTypeInterface) {
        continue;
    }

    $typeStrings[] = (string) $t;
}

mtarld · 2025-02-26T18:31:05Z

~~Anyway, I don't think the deprecation can be triggered before January 2026 (before the EOL of PHP 8.1), so we have plenty of time 🙂~~

Edit: I was wrong about it, there is no need to wait, the deprecation could be merged in Symfony 7.3

src/Metadata/Property/Factory/AttributePropertyMetadataFactory.php

src/Metadata/Util/PropertyInfoToTypeInfoHelper.php

src/Metadata/Tests/Extractor/PropertyMetadataCompatibilityTest.php

src/Doctrine/Odm/PropertyInfo/DoctrineExtractor.php

src/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php

src/Metadata/Property/Factory/SerializerPropertyMetadataFactory.php

src/Metadata/Extractor/XmlPropertyExtractor.php

src/Metadata/Extractor/YamlPropertyExtractor.php

src/Metadata/Extractor/schema/properties.xsd

This PR was merged into the 7.3 branch. Discussion ---------- [PropertyInfo] Deprecate `Type` | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | no | Deprecations? | yes | Issues | | License | MIT A new attempt to #53160, now that `symfony/type-info` is not experimental anymore. Deprecates: - `Type` class in favor of the `Type` class of `symfony/type-info` - `PropertyTypeExtractorInterface::getTypes()` in favor of the `PropertyTypeExtractorInterface::getType()` method - `ConstructorArgumentTypeExtractorInterface::getTypesFromConstructor()` in favor of the `ConstructorArgumentTypeExtractorInterface::getTypeFromConstructor()` method The work for upgrading dependent packages has begun already: - api-platform/core#6979 - symfony/ux#2607 Commits ------- 4d2ccf4 Fix md formatting f819aed [PropertyInfo] Deprecate Type

This PR was merged into the 7.3 branch. Discussion ---------- [PropertyInfo] Deprecate `Type` | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | no | Deprecations? | yes | Issues | | License | MIT A new attempt to symfony/symfony#53160, now that `symfony/type-info` is not experimental anymore. Deprecates: - `Type` class in favor of the `Type` class of `symfony/type-info` - `PropertyTypeExtractorInterface::getTypes()` in favor of the `PropertyTypeExtractorInterface::getType()` method - `ConstructorArgumentTypeExtractorInterface::getTypesFromConstructor()` in favor of the `ConstructorArgumentTypeExtractorInterface::getTypeFromConstructor()` method The work for upgrading dependent packages has begun already: - api-platform/core#6979 - symfony/ux#2607 Commits ------- 4d2ccf4ac94 Fix md formatting f819aed8d13 [PropertyInfo] Deprecate Type

src/Doctrine/Odm/composer.json

uncomment deprecations

soyuka · 2025-04-16T19:31:15Z

I'm merging this starting work, we'll continue working towards the main branch based on pull requests on the fork at https://github.com/mtarld/core/pulls. Or else it makes it hard to review properly.

Tests are red for deprecations as we introduced a bunch, no worries the BC layer should be easy enough.
Symfony 7.3 will be out in one month from now, therefore we keep the type-info component in dev mode until the last patches are out, this helps us with patches upstream.

I'll cherry-pick everything by keeping the backward layer, thanks @mtarld for starting this!

mtarld marked this pull request as draft February 21, 2025 14:54

mtarld force-pushed the chore/type-info-type-metadata branch 2 times, most recently from 9f1eab4 to 99cfee3 Compare February 21, 2025 15:43

mtarld changed the title ~~[Metadata] Use Type of TypeInfo instead of PropertyInfo~~ feat(metadata): Use Type of TypeInfo instead of PropertyInfo Feb 21, 2025

mtarld force-pushed the chore/type-info-type-metadata branch from 99cfee3 to ffd86b8 Compare February 21, 2025 15:53

mtarld changed the title ~~feat(metadata): Use Type of TypeInfo instead of PropertyInfo~~ feat(metadata/doctrine): Use Type of TypeInfo instead of PropertyInfo Feb 21, 2025

mtarld force-pushed the chore/type-info-type-metadata branch 9 times, most recently from d8618a7 to 6e47055 Compare February 22, 2025 10:20

mtarld marked this pull request as ready for review February 22, 2025 10:40

mtarld force-pushed the chore/type-info-type-metadata branch from f44914f to 6e47055 Compare February 24, 2025 13:00